docs: add debugging error lookup table#1884
Conversation
|
😎 Merged manually by @heyong4725 - details. |
|
@GHX5T-SOL the Trunk merge queue failed for this PR. See the Trunk merge-status comment for details. Posted as a new comment so GitHub sends an email — Trunk's sticky comment is edited in place and won't trigger a notification. |
600d842 to
9cf6f93
Compare
|
Rebased this branch on current Validation:
|
|
/trunk merge |
|
An error occurred while submitting your PR to the queue: |
|
Did a verification pass on the table. Every error message fragment was sourced from a real codebase string — I grep-checked all 13 and they all match. The Two notes worth flagging: 1.
|
|
Addressed the debugging-table/doc syntax notes in 917b4f2.\n\nChanges:\n- Replaced the nonexistent |
|
Nice work on the error table — verified all 13 error fragments exist in the codebase, the "likely cause" and "next step" columns are accurate and actionable. One issue to fix before this can landThe 7 See /// Show logs for the given node (omit with --all-nodes)
#[clap(value_name = "NAME")]
pub node: Option<NodeId>,And A user following this PR's examples will hit 7 lines to revert
The sister doc What's solid (don't change)The error table itself (lines 117-138) is the meat of the PR and it's well-done:
Each "likely cause" reads accurate and each "next step" is a runnable command. This is the right level of detail for the lookup table #1878 asked for. Also worth checkingBranch is 22 commits behind main (last sync 2026-05-20 at TL;DR
|
|
Correction to my earlier review — I missed PR #1883. PR #1883 (also from @GHX5T-SOL, addressing issue #1880) is the upstream CLI change that adds the My earlier P1 was wrong. Sorry for the noise — I should have looked at the contributor's other open PRs before flagging the syntax. Updated recommendation
Suggested merge sequence
If you'd rather land #1884 first, you'd need to coordinate with #1883's docs/debugging.md diff manually — but the rebase path is much simpler. What still stands
|
917b4f2 to
31bf100
Compare
|
Rebased on main for you (PR opted into maintainer edits, so I pushed directly). New head: Now that #1883 has landed ( Before rebase: 1 file changed, 31+/5- (TOC link + error table + 5 syntax adjustments) The error table content is unchanged — all 13 verified error fragments still there. CI will rerun on the new head; once green, this is ready to merge. |
… (#1946) `examples/rust-dataflow-git/dataflow.yml` was pinned to commit `10cf7fe9c082caaa90679bcca48c873cdc16311b` (2026-04-28), 74 commits behind main, including major message-format and node-to-daemon protocol changes. The example's nodes — built from the pinned rev — no longer understood the protocol the current dora-cli speaks, so `cargo run --example rust-dataflow-git` hung indefinitely. This is exactly what the dataflow.yml comment warns about: > Smoke-tests git-sourced nodes. Pins to a dora commit (not a > released tag) so the example runs against matching message-format > versions without needing a release. Update `rev:` when a > message-format-breaking change lands on main — otherwise the CI > job catches the mismatch and signals a compatibility break, which > is the whole point of this test. The job has done its job. Bumping the pin to current main (the post-#1884 commit `9f4242b69720dd6c4da44260cc4102541dcf7d70`) restores 1:1 protocol parity between the example's nodes and the CLI they're invoked from. ## Symptoms before this fix `ci/circleci: examples-windows` failed on 9 consecutive main commits since 2026-05-26 05:16 UTC. `examples-linux` failed on most of them. Both jobs timed out at the same step ("Rust Git Dataflow example", `no_output_timeout: 30m`): [success ] 19.7m Build examples + CLI binary [success ] 10.4m Rust Dataflow example [timedout] 28.9m Rust Git Dataflow example <-- here ## Local validation pkill -9 dora; rm -rf examples/rust-dataflow-git/git cargo run --example rust-dataflow-git Before bump: nodes built from the stale rev hang during dataflow start (no STOP-message handshake compatibility). After bump: nodes build from current main source tree, dataflow runs cleanly. Full local execution takes 20+ min (build of the pinned dora source tree + arrow + zenoh deps), so the conclusive smoke runs in CI on the resulting workflow. ## Follow-up The medium-term recurrence prevention discussed in #1945 (add the example to required checks, scheduled auto-bump, or contributor docs) is out of scope here. This PR is the short-term unblock. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Addresses the common-error-message table slice of #1878.
What changed:
Common Error Messagessection todocs/debugging.md.Validation:
git diff origin/main..HEAD --checkgit show --format= --patch HEAD | gitleaks stdin --no-banner --redact --timeout 30-> no leaks foundNot run: cargo tests; docs-only change.